<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 transitional//EN">
<html>
<head>
<title>Library Element</title>
<link rel="stylesheet" href="../style/style.css" type="text/css"/>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</head>
<body>
<h1>Library</h1>

<p>Predefined set of components and rules.</p>

<h3>Description</h3>

<p>A BIRT report library is a collection of report components that can be used in a 
report design. Report components include reusable visual report items, data sources,
data sets, parameters, translations and more. 

<p>A library is a customizable, pre-defined set of rules that helps a user quickly create 
a report with a specific look. 

<p>A BIRT library includes both formatting information and rules that help you the developer 
create a report. A library is like a "skin" for a report; it takes the data, structure and 
layout of a report and applies formatting defined in the library to transform the report's 
appearance. 

<p>A library may start with a "style sheet": a set of common styles to apply to all reports 
within an application. The library can then add commonly-used data sources, reusable components, 
translated text, images and more.</p>

<h2 class="slot">themes</h2>

<p>Contains a number of themes. Theme is a container for styles</p>

<h3>Description</h3>

<p>Styles in a library is defined inside a theme, a report design first use the theme from a
library, then reuse a style within the theme.</p>

<h3>See Also</h3>

<h2 class="slot">parameters</h2>

<p>A list of resuable Parameter elements that describe the data that the user can enter when running the report.</p>

<h3>Description</h3>

<p>A list of parameter elements that describe the data that 
the user can enter when running the report. BIRT supports four kinds of 
parameters identified above. The design can also include parameter groups that 
organize parameters visually.</p>

<p>Such parameters don't appear in the report's "requester page" unit a report 
uses them. The result uses a reusable parameter by defining a new parameter 
that extends the parameter defined in the library. In most cases, the report 
design simply inherits all characteristics of the reusable parameter.</p>

<p>The order of parameters within this slot in the design 
file determines the order that they will appear in the requester UI.</p>

<p>The parameters property provides a &quot;flattened&quot; list of 
parameters. Each parameter identifies the group (if any) to which it belongs.</p>
<p>Parameter values are also available using the
<code>params</code> global variable.</p>


<h3>See Also</h3>

<h2 class="slot">dataSources</h2>

<p>Reusable connections that can be used a report.</p>

<h3>Description</h3>

<p>This slot holds the list of reusable data sources. Each data source must have a unique name. 
The order of items within this slot is unimportant.</p>

<h3>See Also</h3>


<h2 class="slot">dataSets</h2>

<p>Reusable Data sets (queries).</p>

<h3>Description</h3>

<p>This slot holds the list of usable data sets. Each data set must have a unique name.
The order of items within this slot is unimportant.</p>


<h3>See Also</h3>

<h2 class="slot">pageSetup</h2>

<p>Master pages are reusable components available to report designs.</p>

<h3>Description</h3>

<p>Master pages are reusable components available to report designs.The report design can 
simply reuse a library master page, can extend and customize a library master page, or can 
define a page just for that report design.</p>

<p>The page setup defines the way that the report will 
appear when printed. It consists of a master page that defines the page size, 
page &quot;decoration&quot;, margins and so on. Some reports need to use different master 
pages, perhaps to have the first page of the report appear in letterhead, with 
the remaining pages on plain paper. Other reports may be printed and bound, 
requiring differing page layout for the left and right pages.</p>

<p>A report can omit the page setup information. If so, page 
setup is taken from a library, if provided. If the library is not provided, or 
does not have a page setup, or the master page does not have page dimensions, 
then the setup comes from BIRT preferences, or from locale-specific defaults.</p>

<p>If the user lists multiple master pages, but no page 
sequences, then BIRT uses the first master page by default. If the user defines 
one or more page sequences, then BIRT uses the first page sequence by default. 
Other than these two cases, the order of elements within the page setup slot is 
unimportant.</p>

<p>This slot defines a name space; the name of each master 
page and page sequence must be unique across the set of other page setup 
elements.</p>

<p>Only the simple master page is available in the first 
release, and the design can contain at most one simple master page in the first 
release.</p>

<p>The page setup can contain zero or more master pages (of 
either type) and zero or more page sequences (of either type). The simplest 
report provides no master page. It will appear with the default pages size and 
margins, and with no page header or footer.</p>

<h3>See Also</h3>

<h2 class="slot">components</h2>

<p>Reusable report items defined in this design. Report 
items can extend these items. Defines a &quot;private library&quot; for this design.</p>

<h3>Description</h3>

<p>This slot defines reusable report items. A report developer may want to use 
  the same image, text, label or other item in several places within in the report. 
  Instead of copying &amp; pasting, the developer can instead define the element 
  once in the library components slot. Then, he can use library to create the 
  various instances.</p>

<p>&nbsp;</p>

</body>
</html>